JxBrowser/com.teamdev.jxbrowser.dom/[jvm]FormElement

FormElement

public interface FormElement implements Element

An HTML DOM form element.

Provides access to the contained control elements and the attributes of the form element.

Properties

attributes

public final ElementAttributes attributes

Returns HTML attributes of this element.

innerHtml

public final String innerHtml

Returns a string with the HTML content of this element, or an empty string if the element does not have inner HTML.

innerText

public final String innerText

Returns a string with the content of the element and its descendants, or an empty string if this element does not have a content.

nextSibling

public final Node nextSibling

Returns the next node in the document tree, if any.

outerHtml

public final String outerHtml

Returns a string with the HTML serialization of this element and its descendants.

parent

public final Node parent

Returns the parent of this node, if any.

previousSibling

public final Node previousSibling

Returns the previous node in the document tree, if any.

xPath

public final XPathExpression xPath

Returns XPathExpression that represents path to this Node, or an empty expression if it is not available.

Functions

action

public abstract String action()

Returns the value of the action attribute of this form.

addEventListener

public abstract void addEventListener(EventType eventType, Observer<Event> listener, boolean useCapture)

Adds the given listener to the event target.

appendChild

public abstract boolean appendChild(Node childNode)

Adds the given node as a child of the current node to the end of its children list.

attributes

public abstract ElementAttributes attributes()

Returns HTML attributes of this element.

blur

public abstract void blur()

Removes keyboard focus from the current element.

boundingClientRect

public abstract Rect boundingClientRect()

Returns the rectangle bounds of the element and its position relative to the top-left of the viewport of the current document.

children

public abstract List<Node> children()

Returns an immutable list of all children of this node.

click

public abstract void click()

Simulates a click on the node.

public abstract void close()

Closes this node.

compareDocumentPosition

public abstract Set<DocumentPosition> compareDocumentPosition(Node otherNode)

Compares position of the current node against another node in a DOM tree.

controls

public abstract List<FormControlElement> controls()

Returns an immutable list of the form controls or an empty list if the form got no controls on it.

dispatch

public abstract boolean dispatch(Event event)

Dispatches the given event at the current event target.

document

public abstract Document document()

Returns the Document instance of this node.

evaluate

public abstract XPathResult evaluate(String expression)

Evaluates the given XPath expression for the node and returns the XPathResult of the ANY type.

public abstract XPathResult evaluate(String expression, XPathResultType type)

Evaluates the given XPath expression for the node and returns the XPathResult object of the given type.

evaluate

public final XPathResult evaluate(XPathExpression expression)

Evaluates the given expression for the node and returns XPathResult of the XPathResultType.ANY type.

public final XPathResult evaluate(XPathExpression expression, XPathResultType type)

Evaluates the given expression for the node and returns XPathResult of the given type.

eventListeners

public abstract List<Observer<Event>> eventListeners(EventType eventType, boolean useCapture)

Returns the immutable list of event listeners that listen events of the given


eventType

in a phase that corresponds the given useCapture.

findByClassName

public final Element findByClassName(String className)

Returns the first Element found in the current search context by the given className, if any.

findByCssSelector

public final Element findByCssSelector(String cssSelector)

Returns the first Element found in the current search context by the given cssSelector, if any.

findById

public final Element findById(String id)

Returns the first Element found in the current search context by the given id, if any.

findByName

public final Element findByName(String name)

Returns the first Element found in the current search context by the given name, if any.

findByTagName

public final Element findByTagName(String tagName)

Returns the first Element found in the current search context by the given tagName, if any.

findElementByClassName

public abstract Optional<Element> findElementByClassName(String className)

Returns the first Element object found in the current search context by the given className.

findElementByCssSelector

public abstract Optional<Element> findElementByCssSelector(String cssSelector)

Returns the first Element object found in the current search context by the given cssSelector.

findElementById

public abstract Optional<Element> findElementById(String id)

Returns the first Element object found in the current search context by the given id.

findElementByName

public abstract Optional<Element> findElementByName(String name)

Returns the first Element object found in the current search context by the given name.

findElementByTagName

public abstract Optional<Element> findElementByTagName(String tagName)

Returns the first Element object found in the current search context by the given tagName.

findElementsByClassName

public abstract List<Element> findElementsByClassName(String className)

Returns an immutable list of the Element objects found in the current search context by the given className.

findElementsByCssSelector

public abstract List<Element> findElementsByCssSelector(String cssSelector)

Returns an immutable list of the Element objects found in the current search context by the given cssSelector.

findElementsById

public abstract List<Element> findElementsById(String id)

Returns an immutable list of the Element objects found in the current search context by the given id.

findElementsByName

public abstract List<Element> findElementsByName(String name)

Returns an immutable list of the Element objects found in the current search context by the given name.

findElementsByTagName

public abstract List<Element> findElementsByTagName(String tagName)

Returns an immutable list of the Element objects found in the current search context by the given tagName.

focus

public abstract void focus()

Sets focus on this element, if it can be focused.

getByClassName

public final Element getByClassName(String className)

Returns the first Element found in the current search context by the given className.

getByCssSelector

public final Element getByCssSelector(String cssSelector)

Returns the first Element found in the current search context by the given cssSelector.

getById

public final Element getById(String id)

Returns the first Element found in the current search context by the given id.

getByName

public final Element getByName(String name)

Returns the first Element found in the current search context by the given name.

getByTagName

public final Element getByTagName(String tagName)

Returns the first Element found in the current search context by the given tagName.

innerHtml

public abstract String innerHtml()

Returns a string with the HTML content of this element, or an empty string if the element does not have inner HTML.

public abstract boolean innerHtml(String html)

Replaces the HTML content of this element with the given html.

innerText

public abstract String innerText()

Returns a string with the text content of the element and its descendants.

public abstract boolean innerText(String innerText)

Replaces the text content of the element with the given innerText value.

insertChild

public abstract boolean insertChild(Node node, Node beforeNode)

Inserts the given node before the given beforeNode as a child of the current node.

method

public abstract String method()

Returns the value of the method attribute of this form.

name

public abstract String name()

Returns the value of the name attribute of this form.

nextSibling

public abstract Optional<Node> nextSibling()

Returns an Optional that contains the next node in the document tree if such a node exists, otherwise returns an empty Optional.

nodeName

public abstract String nodeName()

Returns a string that represents the node name in the UTF8 format.

nodeValue

public abstract String nodeValue()

Returns a string that represents the node value.

public abstract void nodeValue(String value)

Updates the node value with the given new value.

outerHtml

public abstract String outerHtml()

Returns a string with the HTML serialization of this element and its descendants.

public abstract boolean outerHtml(String html)

Replaces the element and all of its descendants with a new DOM tree constructed by parsing the given html.

parent

public abstract Optional<Node> parent()

Returns an Optional that contains the parent of this node.

previousSibling

public abstract Optional<Node> previousSibling()

Returns an Optional that contains the previous node in the document tree if such a node exists, otherwise returns an empty Optional.

removeChild

public abstract boolean removeChild(Node childNode)

Removes the given childNode of the current node from the DOM.

removeEventListener

public abstract void removeEventListener(EventType eventType, Observer<Event> listener, boolean useCapture)

Removes the given listener from the event target.

replaceChild

public abstract boolean replaceChild(Node newNode, Node oldNode)

Replaces the given child oldNode of the current node with the given newNode.

reset

public abstract void reset()

Restores default values of the elements on the form.

scrollIntoView

public abstract void scrollIntoView(Element.AlignTo alignTo)

Scrolls the element's parent container such that the element on which this method is called is visible to the user.

submit

public abstract void submit()

Submits the form represented by the element.

textContent

public abstract String textContent()

Returns the text content of the current node and its descendants.

public abstract void textContent(String textContent)

Removes all the current node children and replaces them with a single text node with the given textContent.

type

public abstract NodeType type()

Returns the node type.

xPath

public abstract String xPath()

Returns a string that represents XPath to the current Node or an empty string if it is not available.